Computer Science

User Focus and Documentation

User Documentation

  • A well-made user documentation guides the user through using the system and thus increases productivity.
  • It provides the end-users with information on the system and if the user documentation is well written, it can greatly speed up the implementation of the system.

Methods of Providing User Documentation

Type Description Advantages Disadvantages
Help Files Files supplied along with the system, usually accessible via a button.
  • Accessible anytime when using the program.
  • Provide general instructions on system use and solving errors.
  • Usable only after system installation.
  • Not helpful during installation.
  • Deal with general errors, not specific problems.
  • Lack search capability; users must browse for help.
Online Support Web service provided by the system's developer.
  • Frequently Asked Questions (FAQs) available.
  • Live support for customized help.
  • Search capabilities.
  • Requires internet connection.
  • Live support may not work well with users unfamiliar with computers.
Printed Manuals Paper manuals supplied with the system.
  • Can be read before starting the system.
  • Always available; no internet needed.
  • Provide help with system installation and use.
  • Can be lost/misplaced.
  • Usually limited to installation instructions.
  • May not be updated with system updates.
  • Users often avoid them due to long texts.

Methods of Providing User Training

Type Description Advantages Disadvantages
Self-Training Users learn independently using manuals or tutorials.
  • Cheap; minimal resources needed.
  • Flexible timeline.
  • Tailored to user’s preferences and pace.
  • No guidance; users may feel lost.
  • Features can be misunderstood.
Formal Classes Structured classroom training led by an instructor.
  • Expert available for tailored answers.
  • Structured curriculum covering all aspects.
  • Expensive; requires teachers and infrastructure.
  • Inflexible schedule.
  • Limited personalization.
Remote/Online Training Instructor-led training via a remote connection.
  • Structured learning with an expert on hand.
  • Flexible location.
  • Expensive; requires internet and instructors.
  • Can feel impersonal and less engaging.